Приложение Б.
Руководство пользователя.
АННОТАЦИЯ
Данное приложение позволяет ознакомиться с руководством
пользователя по работе с приложением. Документ описывает назначение
программы, условия выполнения программы, выполнение программы и
сообщения оператору.
- 2 -
СОДЕРЖАНИЕ
ВВЕДЕНИЕ ...................................................................................................... 3
1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ .................................... 4
2. ПОДГОТОВКА К РАБОТЕ ..................................................................... 5
2.1. Состав и содержание дистрибутивного носителя данных .......... 5
2.2. Порядок загрузки данных и программ .......................................... 5
2.3. Порядок проверки работоспособности ....................................... 11
3. ОПИСАНИЕ ОПЕРАЦИЙ ..................................................................... 12
3.1. Описание всех выполняемых функций, задач, комплексов задач,
процедур ..................................................................................................... 12
4. АВАРИЙНЫЕ СИТУАЦИИ .................................................................. 35
4.1. Действия в случае несоблюдения условий выполнения
технологического процесса, в том числе при длительных отказах
технических средств ................................................................................. 35
4.2. Действия по восстановлению программ и/или данных при отказе
магнитных носителей или обнаружении ошибок в данных ................. 35
4.3. Действия в случаях обнаружении несанкционированного
вмешательства в данные ........................................................................... 35
4.4. Действия в других аварийных ситуациях ................................... 36
- 3 -
ВВЕДЕНИЕ
Областью применения разработанного приложения является
хранение и работа с изображениями, а также сбор статистических данных
о работе пользователей в приложении.
Приложения обладает возможностью загрузки и хранения
изображений на удаленном сервере, редактирования изображений,
группировки изображений в альбомы, скачивания отдельных
изображений или целых альбомов на персональный компьютер.
Для того чтобы пользоваться приложением пользователю
достаточно иметь начальный уровень подготовки по работе в веб-
браузере. Администратор приложения должен иметь навыки работы с
базами данных, а также уметь работать с панелью управления хостингом.
В перечень эксплуатационной документации, с которой
необходимо ознакомиться пользователю входит данное руководство
пользователю, а также справка по работе с браузером.
- 4 -
1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ
В таблице 1.1 представлены минимальные и рекомендуемые
технические характеристики для работы с приложением.
Таблица 1.1 – Технические характеристики
Название компонента
Характеристика
Минимальные требования
CPU
Не менее 1000 МГц, 2 ядра, 64 бита
RAM
Не менее 2 Гб
HDD/SSD
Не менее 30 Гб
Видеоадаптер
GeForce GT 320
Сетевая карта
Не менее 1-ого порта Ethernet 100 Mb/s
Монитор
Разрешение не менее 1400х900
Манипуляторы
Оптическая компьютерная мышь
Устройства ввода
Клавиатура
Рекомендуемые требования
CPU
Не менее 1800 МГц, 4 ядра, 64 бита
RAM
4 Гб
HDD/SSD
50 Гб
Видеоадаптер
GeForce GT 650
В таблице 1.2. представлено системное программное обеспечения
для работы с программой.
Таблица 1.2 – Системное программное обеспечение
Название
Характеристика
Операционная система
Windows 7, 8, 10, Linux
Браузер
Google Chrome, Yandex Browser, Firefox
Программная платформа
С поддержкой .Net Core 3.0
Веб-интерфейс администрирования
СУБД
phpMyAdmin
- 5 -
2. ПОДГОТОВКА К РАБОТЕ
2.1. Состав и содержание дистрибутивного носителя данных
Состав дистрибутивного носителя данных представлен в таблице
2.1.
Таблица 2.1. – Состав дистрибутивного носителя данных
Наименование
Описание
README.txt
Текстовый файл с информацией по
настройке информационной системы.
ImageGallery.sql
Дамп базы данных для работы
приложения.
Папка ImageGallery
Папка содержит в себе исходные файлы
приложения.
2.2. Порядок загрузки данных и программ
Для того, чтоб пользователи могли создать свои аккаунты в
приложении, а также для хранения другой информации, необходимо
создать базу данных на хостинге (рис. 2.1).
Рисунок 2.1 – Создание базы данных на сервере
После создания нужно импортировать таблицы и конфигурацию из
дампа базы данных ImaggeGallery.sql в базу данных на сервере (рис. 2.2).
- 6 -
Рисунок 2.2 – Импорт базы данных
На рисунке 2.3 представлена структура импортированной базы
данных.
Рисунок 2.3 – Структура базы данных
Для публикации приложения на сервере из инструментальной
среды Visual Studio 2019 необходимо настроить веб-развертывание.
Для начала необходимо выбрать пункт опубликовать ImageGallery
(рис. 2.4).
- 7 -
Рисунок 2.4 – Выбор пункта публикации
В открывшемся окне выбрать пункт IIS, FTP, веб-развертывание
(рис. 2.5).
Рисунок 2.5 – Выбор способа развертывания
Затем необходимо правильно заполнить все поля для подключения
к серверу (рис. 2.6).
- 8 -
Рисунок 2.6 – Заполнение профиля
Также нужно ввести строку подключения для взаимодействия
приложения с базой данных (рис. 2.7).
- 9 -
Рисунок 2.7 – Настройка подключения к базе данных
После чего необходимо сохранить введенные ранее настройки (рис.
2.8).
Рисунок 2.8 – Сохраненные настройки
После сохранения и проверки настроек, необходимо нажать кнопку
публикации и в открывшемся окне ввести пароль для подключения к
хостингу (рис. 2.9).
- 10 -
Рисунок 2.9 – Ввод пароля
После этого все необходимые файлы для работы веб-сервиса будут
загружены на сервер (рис. 2.10).
Рисунок 2.10 – Файлы приложения на сервере
Затем необходимо изменить файл web.config чтобы приложение
начало работать (рис. 2.11).
- 11 -
Рисунок 2.11 – Изменение файла web.config
2.3. Порядок проверки работоспособности
Для того чтобы проверить работоспособность приложения,
необходимо в браузере в адресной строке набрать адрес сайта и перейти
по нему (рис. 2.12).
Рисунок 2.12 – Набор доменного имени сайта
- 12 -
3. ОПИСАНИЕ ОПЕРАЦИЙ
3.1. Описание всех выполняемых функций, задач, комплексов задач,
процедур
Для того чтобы перейти на окно авторизации, пользователю
достаточно набрать в адресной строке доменное имя сайта. После чего
пользователь должен ввести логин и пароль, который предоставил ему
администратор приложения, для авторизации в системе (рис. 3.1).
Рисунок 3.1 – Авторизация пользователя
Если комбинация логина и пароля, которую ввел пользователь
зарегистрирована в системе, ему разрешается доступ к системе, и он
автоматически перенаправляется на домашнюю страницу (рис. 3.2).
- 13 -
Рисунок 3.2 – Домашняя страница пользователя
На домашней странице пользователь может видеть все свои
альбомы с изображениями, а также альбомы других пользователей, если
они открыли к ним доступ.
При нажатии на название альбома в крайнем левом столбце,
пользователь перенаправится на страницу альбома, где сможет увидеть
все изображения, которые содержаться в альбоме (рис. 3.3).
- 14 -
Рисунок 3.3 – Страница альбома
Также на данной странице, сотрудник может видеть описание
альбома, если оно было введено. Помимо этого, пользователю из данной
странице предоставлена возможность перейти сразу на страницу
добавления изображения, изменения альбома, удаления альбома. Также,
нажав на кнопку «Скачать альбом» на персональный компьютер
пользователя скачается архив, где будут содержаться все изображения,
которые находились в просматриваемом альбоме (рис. 3.4 – 3.5).
- 15 -
Рисунок 3.4 – Архив скачался
Рисунок 3.5 – Скачанный архив
Если нажать на само изображение, то оно откроется на весь экран
(рис. 3.6), что позволяет более детально рассмотреть изображение.
- 16 -
Рисунок 3.6 – Просмотр изображения
Также под каждым изображением находятся иконки следующих
функций: «Редактировать изображение», «Скачать изображение»,
«Удалить изображение» (рис. 3.7).
Рисунок 3.7 – Иконки функций
При нажатии на иконку функции удаления изображения откроется
страница, на которой пользователь должен будет подтвердить свои
намерения (рис. 3.8).
- 17 -
Рисунок 3.8 – Страница подтверждения удаления изображения
После нажатия кнопки «Удалить» и подтверждения удаления
изображения, изображение и данные о нем удалятся из системы, а
пользователь будет перенаправлен на страницу «Изображения».
При нажатии на иконку скачивания изображения, изображения
отдельным файлом скачается на компьютер пользователя (рис. 3.9 – 3.10).
- 18 -
Рисунок 3.9 – Изображение скачалось
Рисунок 3.10 – Скачанное изображение
При нажатии на иконку редактирования изображения, перед
пользователем откроется новая страница (рис 3.11).
- 19 -
Рисунок 3.11 – Страница редактирования изображения
Если нажать на кнопку «Работа с изображением», откроется форма,
на которой будут указаны все возможные функции редактирования
изображения (рис. 3.12).
Рисунок 3.12 – Функции редактирования изображения
Для того чтобы изменить яркость, контрастность, или цветовые
параметры изображения, необходимо передвинуть ползунок, выбранного
параметра и после чего нажать на кнопку «Изменить» (рис. 3.13 – 3.14).
- 20 -
Рисунок 3.13 – Изменение значения ползунка
Рисунок 3.14 – Измененное изображение
Чтобы отменить изменения достаточно нажать на стрелку, которая
показывает влево, в браузере. Однако отменить изменения возможно
только если они еще не были сохранены.
Для выполнения функций, которые представлены одиночными
кнопками, достаточно просто нажать на эти кнопки.
Особое внимание следует уделить функции кадрирования
изображения. Для того чтобы выбрать область кадрирования необходимо
- 21 -
нажать на кнопку «Выбрать область кадрирования», после чего
покажется область, где можно будет обрезать изображение (рис. 3.15).
Рисунок 3.15 – Выбор области кадрирования
После выбора области нужно нажать на кнопку «Кадрировать»,
чтобы получить обрезанное изображение (рис. 3.16).
Рисунок 3.16 – Обрезанное изображение
Также на изображения можно добавить водяной знак. Он будет
показываться в правом нижнем углу. Чтобы воспользоваться данной
функцией, необходимо в строку ввести надпись, которая будет
- 22 -
отображаться на изображении и нажать на кнопку «Добавить водяной
знак» (рис. 3.17 – 3.18).
Рисунок 3.17 – Ввод надписи водяного знака
Рисунок 3.18 – Добавленный водяной знак
Чтобы применить несколько функции редактирования
изображения, необходимо сначала выполнить одну функцию, после чего
выбрать другую.
Чтобы сохранить измененное изображение на сервере, необходимо
нажать на кнопку «Сохранить», после чего при удачном сохранение
появится окно с сообщение (рис. 3.19 – 3.20).
- 23 -
Рисунок 3.19 – Оповещение об успешном сохранении изображения
Рисунок 3.20 – сохраненное изменённое изображение
На странице «Альбомы» в таблице представлен список всех
альбомов, созданных самим пользователем, а также альбомы, которые
имеют общий доступ. (рис. 3.21).
- 24 -
Рисунок 3.21 – Страница «Альбомы»
Для создания нового альбома необходимо нажать на кнопку
«Создать альбом», после чего откроется новая страница (рис. 3.22).
Рисунок 3.22 – Страница создания альбома
Поле «Название альбома» является обязательным для заполнения,
может состоять из любых символов. В поле «Описание альбома»
хранится описание альбома. Также если отметить галочкой пункт
доступность альбома «Всем», то это будет означать, что изменять данный
альбом, удалять, как-либо взаимодействовать с изображениями в данном
альбоме сможет любой пользователь системы. Если данный пункт не
- 25 -
отмечен, то все функции с альбомом может выполнять только
пользователь и администратор системы.
Страница изменения альбома состоит из тех же полей, что были
описаны выше (рис. 3.23). При помощи данной страницы изменяются уже
созданные альбомы.
Рисунок 3.23 – Страница изменения альбома
При удалении альбома важно помнить, что удалятся также все
изображения, которые находились в нем на момент удаления (рис. 3.24).
- 26 -
Рисунок 3.24 – Страница удаления альбома
Страница «Изображения» предназначена для просмотра всех
загруженных изображений, а также информации, в каком альбоме они
находятся (рис. 3.25).
Рисунок 3.25 – Страница «Изображения»
Все таблицы, которые представлены в системе поддерживают
фильтрацию, а также сортировку. Для того чтобы отфильтровать список,
- 27 -
необходимо в поле ввести название изображения либо альбома (рис. 3.
26).
Рисунок 3.26 – Фильтрация в таблице
Для того чтобы снова отобразить полный список достаточно нажать
на ссылку «Полный список».
Помимо фильтрации пользователям также доступна сортировка в
таблицах (рис. 3.27). Сортировка выполняется как по возрастанию, так и
по убыванию.
- 28 -
Рисунок 3.27 – Сортировка таблицы
На одной странице могут отображаться только 10 записей таблицы.
Для того чтобы перейти на другую таблицу достаточно нажать на номер
страницы внизу таблицы (рис. 3.28).
Рисунок 3.28 – Пагинация таблицы
Для того чтобы загрузить изображение на удаленный сервер
необходимо нажать на кнопку «Загрузить изображение». После чего
откроется страница загрузки изображения (рис. 3.29).
- 29 -
Рисунок 3.29 -Страница загрузки изображения
При нажатии на кнопку выбрать откроется окно проводника, где
можно будет выбрать одно или сразу несколько изображений для
загрузки. После подтверждения выбора все выбранные изображения
появятся на странице (рис. 3.30). Для загрузки доступны изображения в
формате jpg, jpeg, png, ico, gif, bpm.
Рисунок 3.30 – Выбранные изображения для загрузки
После выбора изображений необходимо выбрать альбом, в который
данные изображения загрузятся и нажать кнопку «Загрузить» (рис. 3.31).
- 30 -
Рисунок 3.31 – Выбор альбома для загрузки
Также можно изменить изображение, которое уже загружено в
систему. Для этого в таблице необходимо нажать на ссылку «Изменить».
На открывшейся страницы предоставляется возможность изменить
альбом, где будет хранится изображение, а также заменить выбранное
изображение в альбоме на другое, выбранное с компьютера (рис. 3.32).
Рисунок 3.32 – Изменение изображения
Помимо всего, пользователь может связаться с разработчиком на
странице «Обратная связь». Для получения ответа последующего ответа,
- 31 -
пользователю необходимо ввести свой адрес электронной почты, а также
тему сообщения и само сообщение (рис. 3.33).
Рисунок 3.33 – Страница отправки сообщения разработчику
Пользователь, для которого установлена роль «Администратор»
имеет доступ ко всем вышеизложенным функциям программы. Кроме
этого, администратор может просматривать и взаимодействовать
абсолютно со всеми альбомами в приложении. Также именно
администратор регистрирует новых пользователей. Для этого
необходимо перейти на страницу «Пользователи» (рис. 3.34).
- 32 -
Рисунок 3.34 – Список пользователей
Для регистрации нового пользователя необходимо нажать на
кнопку «Добавить пользователя». На открывшейся странице необходимо
заполнить все поля (рис. 3.35) и назначить роль пользователю.
Рисунок 3.35 – Регистрация нового пользователя
Для того чтобы изменить данные пользователя, а также логин или
пароль, необходимо нажать на соответствующую ссылку (рис. 3.36).
- 33 -
Рисунок 3.36 – Изменение данных пользователя
Помимо этого пользователя можно также удалить из системы,
однако нужно иметь ввиду что удалятся все альбомы, которые были
созданы пользователем и изображения в них (рис. 3.37). Кроме этого,
администратор не может удалить сам себя, это может сделать только
другой администратор.
Рисунок 3.37 – Удаление пользователя
Администратор имеет также доступ к графическому отображению
собираемых статистических данных. Для этого необходимо перейти на
страницу статистика и выбрать интересующий график (рис. 3.38).
- 34 -
Рисунок 3.38 – Страница статистики
Все пользователи также могут ознакомится с данной
документацией на странице «Документация» (рис. 3.39).
Рисунок 3.39 – Документация
Для выхода из системы необходимо нажать пункт «Выйти» на
панели меню.
- 35 -
4. АВАРИЙНЫЕ СИТУАЦИИ
4.1. Действия в случае несоблюдения условий выполнения
технологического процесса, в том числе при длительных отказах
технических средств
В таблице 4.1 представлен порядок действий при выявлении
неполадок технических средств.
Таблица 4.1 – Порядок действий при неполадках технических средств
Вид отказа
Порядок устранения ошибки
Отказ ПК пользователя
Перезагрузка компьютера, при
необходимости обращение к
системному администратору.
Отказ сервера
Проверка соединения с сетью, при
необходимости обращение к
системному администратору.
4.2. Действия по восстановлению программ и/или данных при отказе
магнитных носителей или обнаружении ошибок в данных
Если сервер расположен внутри компании, тогда обратиться к
системному администратору, иначе обратиться в службу поддержки
хостинга.
4.3. Действия в случаях обнаружении несанкционированного
вмешательства в данные
При фиксировании несанкционированного вмешательства в
программу, следует незамедлительно уведомить о случившемся
инциденте системного администратора, после чего определить какие
данные были подвержены изменению или удалению. После выполнения
данных действий следует:
Восстановить данные вручную через функциональные
возможности ресурса, в случае если подверженных изменению
данных мало;
- 36 -
Восстановить данные из резервной копии источника данных,
обратившись к системному администратору, в случае если
подверженных изменению данных крайне много.
4.4. Действия в других аварийных ситуациях
В таблице 4.2 представлены сообщения об ошибках и способы их
устранения.
Таблица 3
Текст сообщения
Описание
Дальнейшие действия
1
2
3
Данный логин уже
существует в системе!
При регистрации нового
пользователя был введен
логин, который уже есть в
системе.
Указать другой логин.
Администратор не может
изменять роль самому
себе.
При изменении данных
сотрудника
администратор меняет
роль самому себе.
Изменить роль
администратору может
только сам
администратор.
Попросите об этом
другого администратор
или назначьте нового.
Администратор не может
удалить себя из системы.
Попросите удалить вас
другого администратора.
При удалении данных
пользователя
администратор удаляет
свои собственные данные.
Администратора может
удалить только другой
администратор.
Попросите об этом
другого администратор
или назначьте нового.
Длина логина должна
быть от 8 до 16 символов.
При введении логина он
меньше 8 символов или
больше 16 символов.
Ввести данные в
указанном диапазоне.
Длина пароля должна
быть от 8 до 16 символов.
При введении пароля он
меньше 8 символов или
больше 16 символов.
Ввести данные в
указанном диапазоне.
Длина фамилии должна
быть от 1 до 30 символов.
При введении фамилии
она меньше 1 символа
или больше 30 символов.
Ввести данные в
указанном диапазоне.
Пожалуйста, укажите имя
пользователя.
При регистрации не было
указано имя
пользователя.
Указать имя
пользователя.
Отчество должно
состоять только из
русских букв.
При регистрации
пользователя отчество
содержало в себе другие
символы, кроме русских
букв.
Указать отчество
пользователя русскими
буквами.
- 37 -
1
2
3
Логин должен состоять
только из английских
букв и цифр.
При регистрации
пользователя логин
содержал в себе другие
символы, кроме
английских букв и цифр.
Правильно указать логин.
Пароль должен
обязательно содержать
хотя бы одну строчную и
заглавную английскую
букву, цифру и
специальный символ и
состоять только из
английских букв
При регистрации
пользователя пароль не
имел хотя одну заглавную
или прописную
английскую букву, цифру
и специальный символ.
Правильно указать
пароль.
Длина названия альбома
должна быть от 1 до 50
символов.
При введении названия
альбома оно меньше 1
символа или больше 50
символов.
Ввести данные в
указанном диапазоне.
Изображение обязательно
должно находиться в
альбоме.
При загрузке
изображения в систему не
был выбран альбом.
Выбрать альбом, где
будет хранится
изображение.
